/*
 * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package top.continew.admin.auth;

import jakarta.servlet.http.HttpServletRequest;
import top.continew.admin.auth.enums.AuthTypeEnum;
import top.continew.admin.auth.model.req.AuthReq;
import top.continew.admin.system.model.resp.ClientResp;

/**
 * 认证接口
 *
 * @author KAI
 * @since 2024/12/22 14:52:23
 */
public interface AuthHandler<T extends AuthReq, R> {

    /**
     * 执行登录
     *
     * @param authReq 登录请求参数
     * @param request HTTP请求对象
     * @return 登录响应
     */
    R login(T authReq, ClientResp clientResp, HttpServletRequest request);

    /**
     * 获取登录类型
     *
     * @return 登录类型Enum
     */
    AuthTypeEnum getAuthType();

    /**
     * 校验参数
     *
     * @param authReq 登录请求参数
     */
    void validate(T authReq);

}